Autogenerated HTML docs for v1.6.0.2-287-g3791f
diff --git a/technical/api-builtin.html b/technical/api-builtin.html index ca82b85..21fc35f 100644 --- a/technical/api-builtin.html +++ b/technical/api-builtin.html
@@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 7.0.2" /> +<meta name="generator" content="AsciiDoc 8.2.5" /> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -16,8 +16,13 @@ margin: 1em 5% 1em 5%; } -a { color: blue; } -a:visited { color: fuchsia; } +a { + color: blue; + text-decoration: underline; +} +a:visited { + color: fuchsia; +} em { font-style: italic; @@ -39,13 +44,18 @@ line-height: 1.3; } -h1 { +h1, h2, h3 { border-bottom: 2px solid silver; } h2 { - border-bottom: 2px solid silver; padding-top: 0.5em; } +h3 { + float: left; +} +h3 + * { + clear: left; +} div.sectionbody { font-family: serif; @@ -70,7 +80,7 @@ color: #527bbd; font-family: sans-serif; font-weight: bold; - font-size: 1.2em; + font-size: 1.1em; } span#email { } @@ -139,6 +149,9 @@ padding: 0.5em; } +div.listingblock { + margin-right: 0%; +} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; @@ -148,9 +161,13 @@ div.quoteblock > div.content { padding-left: 2.0em; } -div.quoteblock .attribution { + +div.attribution { text-align: right; } +div.verseblock + div.attribution { + text-align: left; +} div.admonitionblock .icon { vertical-align: top; @@ -194,13 +211,12 @@ ul, ol { list-style-position: outside; } -ol.olist2 { +div.olist2 ol { list-style-type: lower-alpha; } div.tableblock > table { - border-color: #527bbd; - border-width: 3px; + border: 3px solid #527bbd; } thead { font-family: sans-serif; @@ -214,6 +230,9 @@ margin-top: 0.8em; margin-bottom: 0.8em; } +div.hlist td { + padding-bottom: 5px; +} td.hlist1 { vertical-align: top; font-style: italic; @@ -226,6 +245,32 @@ @media print { div#footer-badges { display: none; } } + +div#toctitle { + color: #527bbd; + font-family: sans-serif; + font-size: 1.1em; + font-weight: bold; + margin-top: 1.0em; + margin-bottom: 0.1em; +} + +div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { + margin-top: 0; + margin-bottom: 0; +} +div.toclevel2 { + margin-left: 2em; + font-size: 0.9em; +} +div.toclevel3 { + margin-left: 4em; + font-size: 0.9em; +} +div.toclevel4 { + margin-left: 6em; + font-size: 0.9em; +} /* Workarounds for IE6's broken and incomplete CSS2. */ div.sidebar-content { @@ -254,6 +299,9 @@ border-left: 2px solid silver; padding-left: 0.5em; } + +/* IE6 sets dynamically generated links as visited. */ +div#toc a:visited { color: blue; } </style> <title>builtin API</title> </head> @@ -261,11 +309,11 @@ <div id="header"> <h1>builtin API</h1> </div> -<h2>Adding a new built-in</h2> +<h2 id="_adding_a_new_built_in">Adding a new built-in</h2> <div class="sectionbody"> -<p>There are 4 things to do to add a built-in command implementation to -git:</p> -<ol> +<div class="para"><p>There are 4 things to do to add a built-in command implementation to +git:</p></div> +<div class="olist"><ol> <li> <p> Define the implementation of the built-in command <tt>foo</tt> with @@ -290,8 +338,8 @@ <div class="content"> <pre><tt>{ "foo", cmd_foo, <options> },</tt></pre> </div></div> -<p>where options is the bitwise-or of:</p> -<dl> +<div class="para"><p>where options is the bitwise-or of:</p></div> +<div class="vlist"><dl> <dt> <tt>RUN_SETUP</tt> </dt> @@ -322,16 +370,16 @@ This makes only sense when <tt>RUN_SETUP</tt> is also set. </p> </dd> -</dl> +</dl></div> </li> <li> <p> Add <tt>builtin-foo.o</tt> to <tt>BUILTIN_OBJS</tt> in <tt>Makefile</tt>. </p> </li> -</ol> -<p>Additionally, if <tt>foo</tt> is a new command, there are 3 more things to do:</p> -<ol> +</ol></div> +<div class="para"><p>Additionally, if <tt>foo</tt> is a new command, there are 3 more things to do:</p></div> +<div class="olist"><ol> <li> <p> Add tests to <tt>t/</tt> directory. @@ -347,25 +395,25 @@ Add an entry for <tt>git-foo</tt> to <tt>command-list.txt</tt>. </p> </li> -</ol> +</ol></div> </div> -<h2>How a built-in is called</h2> +<h2 id="_how_a_built_in_is_called">How a built-in is called</h2> <div class="sectionbody"> -<p>The implementation <tt>cmd_foo()</tt> takes three parameters, <tt>argc</tt>, <tt>argv, +<div class="para"><p>The implementation <tt>cmd_foo()</tt> takes three parameters, <tt>argc</tt>, <tt>argv, and `prefix</tt>. The first two are similar to what <tt>main()</tt> of a -standalone command would be called with.</p> -<p>When <tt>RUN_SETUP</tt> is specified in the <tt>commands[]</tt> table, and when you +standalone command would be called with.</p></div> +<div class="para"><p>When <tt>RUN_SETUP</tt> is specified in the <tt>commands[]</tt> table, and when you were started from a subdirectory of the work tree, <tt>cmd_foo()</tt> is called after chdir(2) to the top of the work tree, and <tt>prefix</tt> gets the path to the subdirectory the command started from. This allows you to convert a user-supplied pathname (typically relative to that directory) -to a pathname relative to the top of the work tree.</p> -<p>The return value from <tt>cmd_foo()</tt> becomes the exit status of the -command.</p> +to a pathname relative to the top of the work tree.</p></div> +<div class="para"><p>The return value from <tt>cmd_foo()</tt> becomes the exit status of the +command.</p></div> </div> <div id="footer"> <div id="footer-text"> -Last updated 02-Jul-2008 03:02:16 UTC +Last updated 2008-09-19 06:33:26 UTC </div> </div> </body> 